# Yes:
export foo
export bar
export qux

# Yes:
export get_foo, get_bar
export solve_foo, solve_bar

# No:
export foo,
    bar,
    qux

# Yes:
    foo(x::Int64) = abs(x) + 3

    # No:
    foobar(array_data::AbstractArray{T}, item::T) where {T<:Int64} = T[
        abs(x) * abs(item) + 3 for x in array_data
    ]

# Yes:
function Foo(x, y)
    # code ...
    return nothing
end

# Yes:
function foobar(
    df::DataFrame,
    id::Symbol,
    variable::Symbol,
    value::AbstractString,
    prefix::AbstractString="",
)
    # code
end

# Ok:
function foobar(df::DataFrame, id::Symbol, variable::Symbol, value::AbstractString, prefix::AbstractString="")
    # code
end

# No: Don't put any args on the same line as the open parenthesis if they won't all fit.
function foobar(df::DataFrame, id::Symbol, variable::Symbol, value::AbstractString,
    prefix::AbstractString="")

    # code
end

# Yes:
x = 1
y = 2
long_variable = 3

# No:
x             = 1
y             = 2
long_variable = 3

constraint = conic_form!(
    SOCElemConstraint(temp2 + temp3, temp2 - temp3, 2 * temp1),
    unique_conic_forms,
)

arr = [
    some_long_sub_array_A,
    some_long_sub_array_B,
]

nestedarr = [
    [
        some_long_A,
        some_long_B
    ],
    [
        another_long_A,
        another_long_B
    ]
]

str = """
    hello
    world!
    """
cmd = ```
    program
        --flag value
        parameter
    ```

# Yes:
if foo
    println("Hi")
end

for i in 1:10
    println(i)
end

quote
    x = 1
    y = 2
    a = x + y
end

function foo(bar; verbose=false)
    if verbose
        println("baz")
    end

    return bar
end

# 类型参数
mutable struct MySubString{T<:AbstractString} <: AbstractString
    string::T
    offset::Integer
    endof::Integer
end
# 相比于传统方式:
mutable struct MySubString <: AbstractString
    string::AbstractString
    offset::Int
    endof::Int
end

"""
    mysearch(array::MyArray{T}, val::T; verbose=true) where {T} -> Int

Searches the `array` for the `val`. For some reason we don't want to use Julia's
builtin search :)

# Arguments
- `array::MyArray{T}`: the array to search
- `val::T`: the value to search for

# Keywords
- `verbose::Bool=true`: print out progress details

# Returns
- `Int`: the index where `val` is located in the `array`

# Throws
- `NotFoundError`: I guess we could throw an error if `val` isn't found.
"""
function mysearch(array::AbstractArray{T}, val::T) where T
    ...
end

如果参数过多, 可以不用在文档首行中列出:

"""
    Manager(args...; kwargs...) -> Manager

A cluster manager which spawns workers.

# Arguments

- `min_workers::Integer`: The minimum number of workers to spawn or an exception is thrown
- `max_workers::Integer`: The requested number of workers to spawn

# Keywords

- `definition::AbstractString`: Name of the job definition to use. Defaults to the
    definition used within the current instance.
- `name::AbstractString`: ...
- `queue::AbstractString`: ...
"""
function Manager(...)
    ...
end

更多文档相关的规范参考官方文档

# Yes:
@test value == 0

# No:
@test value == 0.0